Refactor (packages/tui/src/component/bg-pulse-render.ts): Function with many parameters - #27
Open
balsulta wants to merge 4 commits into
Open
Refactor (packages/tui/src/component/bg-pulse-render.ts): Function with many parameters#27balsulta wants to merge 4 commits into
balsulta wants to merge 4 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
P1B: Starter Task: Refactoring PR
Use this pull request template to briefly answer the questions below in one to two sentences each.
Feel free to delete this text at the top after filling out the template.
1. Issue
Link to the associated GitHub issue:
#26
Full path to the refactored file:
packages/tui/src/component/bg-pulse-render.ts
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
I think it computed pixel colors and writing them into a buffer frame by frame.
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
The writeRgb function (line 92) and its single call site inside writeLogoTint (line 103).
Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
"Function with many parameters" in writeRgb — BEFORE: count = 6.
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
Having 6 separate params meant anyone calling this function had to remember the right order (r, g, b, a) which is easy to mess up.
What changes did you make to resolve the issue?
I combined the r, g, b, a params into one object param called
"color" so the function only takes 3 params now instead of 6. Updated the one place that calls it too.
How do your changes improve maintainability? Did you consider alternatives?
Now when you call the function you can see which value is which (like color.r) instead of just numbers in a row.
3. Validation
How did you validate that the change is correct?
I ran qlty smells again and the warning was gone. I also ran all the tests (196 passed, 0 failed) and wrote 3 new tests that call the updated function directly to make sure it still works right.
Attach a screenshot of the test coverage showing the lines were executed by the tests.
Attach a screenshot showing the tests that cover the change passing during CI
Attach a screenshot of
qlty smells --no-snippets <full/path/to/file.ts>showing fewer reported issues after the changes.BEFORE
AFTER
